getSchedule

Retrieves the currently active playback schedule for the player.

A Schedule typically defines the sequence of templates, content, or playback instructions that govern what is displayed on the player over a period of time. If no specific schedule is active for the current time (e.g., during initial setup, if all schedules have expired, or if there's a gap in scheduling), this method may return null.

This method can be useful for:

• Understanding the broader context of what is planned for playback.
• Inspecting properties of the overall schedule (e.g., name, ID, duration).
• Debugging scheduling issues by examining the active schedule's configuration.

Note that this method typically returns the overarching schedule. To get the specific template currently rendering within that schedule, use getTemplate.

See also